Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add extra section in 'The recipe meta.yaml' section. #1767

Closed
wants to merge 4 commits into from
Closed

Add extra section in 'The recipe meta.yaml' section. #1767

wants to merge 4 commits into from

Conversation

ssurbhi560
Copy link
Contributor

@ssurbhi560 ssurbhi560 commented Jun 3, 2022

Closes #1331
Added a Extra section in the the recipe meta.yaml explaining how to become a maintainer.

PR Checklist:

  • make all edits to the docs in the src directory, not in docs or in the html files
  • note any issues closed by this PR with closing keywords
  • put any other relevant information below

@ssurbhi560 ssurbhi560 requested a review from a team as a code owner June 3, 2022 12:22
src/maintainer/adding_pkgs.rst Outdated Show resolved Hide resolved
src/maintainer/adding_pkgs.rst Outdated Show resolved Hide resolved
src/maintainer/adding_pkgs.rst Outdated Show resolved Hide resolved
src/maintainer/adding_pkgs.rst Outdated Show resolved Hide resolved
src/maintainer/adding_pkgs.rst Outdated Show resolved Hide resolved
-----

Recipe Maintainer
..................
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe this should be a series of ^^^^^^^^ instead.

Copy link
Contributor Author

@ssurbhi560 ssurbhi560 Jun 6, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's right, @kathatherine, it should be as you suggested; I also read it here. But when I change it from .... to ^^^, it doesn't work, and the heading doesn't show up under this section. It seems weird, but I guess (not sure though) it is because we are using this sequence
[
=== ---> for Sections
---- ---> for Sub-sections
...... ---> for subsubsections
^^^ ---> for section under subsubsection
and so on.
]
in this file, and this might be reason why this doesn't work.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Gotcha. Well, if it works in the output, we'll keep it!

Recipe Maintainer
..................

A maintainer is an individual who is responsible for maintaining and updating one or more feedstock repositories and packages as well as their future versions. They have push access to the feedstock repositories of only the packages they maintain and can merge pull requests into it.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Comma needed after the first "packages".

Replace the "it" at the end of the paragraph with "them".

-----

Recipe Maintainer
..................
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Gotcha. Well, if it works in the output, we'll keep it!

@h-vetinari
Copy link
Member

I think we should mention the feedstock-name: directive from the extra section as well. It's only really relevant for multi-output recipes, but there, it not only determines whether the README is correct, but it's also necessary so that the test section of an output that's named like the feedstock is run correctly, see conda/conda-build#4172

This pull request was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

Explain how to become a maintainer
3 participants